Inside Macintosh: Mac OS 8 Toolbox Reference /

Chapter 1 - Appearance Manager Reference / Appearance Manager Functions

Drawing Appearance-Compliant Menus /

GetThemeMenuBackgroundRegion

NEW WITH THE APPEARANCE MANAGER

Gets the background region a menu occupies.

pascal OSStatus GetThemeMenuBackgroundRegion (
                     const Rect *inMenuRect,
                     ThemeMenuType inMenuType,
                     RgnHandle Region);

inMenuRect

On input, a pointer to a rectangle.

inMenuType

A value specifying the type of menu (pull-down, pop-up, or hierarchical) whose background you wish to obtain; see "Appearance-Compliant Menu Type Constants".

Region

On input, a handle to a window region created by the application. On output, a handle to the region of the specified rectangle.

function result

A result code; see "Result Codes".

DISCUSSION

The GetThemeMenuBackgroundRegion function should be called when you are writing an Appearance-compliant menu bar definition function. It gets the menu background region for the rectangle specified. This rectangle should be the entire menu. The region handle passed is set to the region.

SPECIAL CONSIDERATIONS

Make sure Appearance Manager 1.0.1 is present before calling the GetThemeMenuBackgroundRegion function. See "Appearance Manager Gestalt Selector Constants" for details on how to determine if the Appearance Manager is present and what its version is, if so.